Update Netlist Creation Function Documentation to Prevent Duplicates #2711
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
VPR
|
@AlexandreSinger, could you please review the changes to ensure they meet your expectations? Let me know if there's anything else I should adjust. |
|
Hi @ZohairZaidi , the comments are not what we want to say over these functions. The issue is that these comments say "Create or return an existing" but in reality, if you try and get an existing one it will crash. I think the documentation just needs to be updated to say "Create ..." and then have a special note below it that will say that it crashes if something with that name already exists. |
|
My apologies, fixed! |
|
That looks better to me! Do not worry about the CI checks not passing for the NightlyTests; the CI server for those tests is down. Thank you! |
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Updated the documentation for the AtomNetlist and ClusteredNetlist classes to reflect the new behavior of the create_* functions. The documentation now specifies that these functions will return the existing ID if an element (block, port, pin, or net) with the specified name or ID already exists, instead of creating a duplicate
Related Issue
closes #2690
Motivation and Context
The update was necessary to avoid performance issues caused by unnecessary duplicate creations in the netlist
How Has This Been Tested?
Types of changes
Checklist: